home *** CD-ROM | disk | FTP | other *** search
/ Aminet 43 / Aminet 43 (2001)(GTI - Schatztruhe)[!][Jun 2001].iso / Aminet / dev / misc / vahunz.readme < prev   
Text File  |  2001-05-03  |  7KB  |  188 lines
  1. Short: Make source code un-/more legible.
  2.  
  3. TITLE
  4.  
  5.   vahunz - Make source code un-/more legible.
  6.  
  7. VERSION 
  8.  
  9.   1.7
  10.  
  11. AUTHOR
  12.  
  13.   Thomas Aglassinger <agi@giga.or.at>
  14.  
  15. DESCRIPTION
  16.  
  17.   Vahunz is a CLI-based replace command that can replace many words
  18.   across several files with only one invocation.
  19.  
  20.   Normally the target words will be created randomly, turning
  21.   meaningful names into unlegible garbage. For example, a function
  22.   name like read_input_file() could be replaced by g7B() or something
  23.   as useless. Additionally, comments and indention can be removed.
  24.  
  25.   As an option, you can specify specific substitutes, so Vahunz can
  26.   also be applied in a non-destructive manner. This can be used to
  27.   replace inconsistent, too short or unlegible names by something more
  28.   meaningful. Among programmers, this process is known as "The Great
  29.   Renaming".
  30.  
  31.   An Amiga Installer script acting as frontend to the CLI command is
  32.   included, so most tasks can be performed without having to deal with
  33.   cryptic command line options.
  34.  
  35. FEATURES
  36.  
  37.   - Stores less/more legible copy in a different directory
  38.   - Supports C, C++ and Java
  39.   - Auto-detects programming language
  40.   - New names since last run are easy to see
  41.   - Names can easily be declared to be modified or left untouched;
  42.     for example, it makes no sense to replace printf().
  43.   - Words being part of comments or string constants are not replaced
  44.   - Fast, as internally names are stored in an AVL-tree
  45.   - Several options to back-trace problems in vahunzed code
  46.   - Includes a set of standard dictionaries for various environments
  47.   - Includes source code (vahunzed ANSI C)
  48.  
  49. NEW FEATURES
  50.  
  51.   - Fixed some bugs
  52.  
  53. SPECIAL REQUIREMENTS
  54.  
  55.   AmigaOS 2.04, 2MB of regular memory, 68020
  56.  
  57. AVAILABILITY
  58.  
  59.   - Every Aminet-mirror, file "dev/misc/vahunz.lha", for example:
  60.  
  61.     ftp://wuarchive.wustl.edu/pub/aminet/dev/misc/vahunz.lha
  62.  
  63.   - http://www.giga.or.at/~agi/vahunz/
  64.  
  65. PRICE
  66.  
  67.   Freeware.
  68.  
  69. DISTRIBUTABILITY
  70.  
  71.   Freely distributable as long the conditions described in the manual
  72.   are met.
  73.  
  74. EXAMPLE
  75.  
  76.   For example, one might have a code excerpt like this:
  77.  
  78.     int main(void)
  79.     {
  80.         while (sepp_age < 83)
  81.         {
  82.             grow_older(sepp_name, &sepp_age);
  83.             print_sepp();
  84.         }
  85.         printf("\n%s died.\n", sepp_name);
  86.         exit(EXIT_SUCCESS);
  87.     }
  88.  
  89.   After vahunzing, this is what it might look like:
  90.  
  91.     int main(void)
  92.     {
  93.     while (g8B < 83)
  94.     {
  95.     z3V(v6Z, &g8B);
  96.     f4V();
  97.     }
  98.     printf("\n%s died.\n", v6Z);
  99.     exit(EXIT_SUCCESS);
  100.     }
  101.  
  102.   As you can see, the internal names have been garbled, but the
  103.   symbols of the standard library are preserved.
  104.  
  105.  
  106. ============================= Archive contents =============================
  107.  
  108. Original  Packed Ratio    Date     Time    Name
  109. -------- ------- ----- --------- --------  -------------
  110.      628     277 55.8% 06-Sep-98 16:34:50  vahunz.info
  111.   208854   69468 66.7% 17-Sep-98 14:42:12 +amiga.ignore
  112.     5325    2313 56.5% 17-Sep-98 14:41:48 +ansi.ignore
  113.        1       1  0.0% 04-Sep-98 13:09:34 +empty.ignore
  114.   151894   47739 68.5% 16-Aug-99 15:54:18 +java.ignore
  115.   187597   65700 64.9% 17-Sep-98 14:42:32 +unix.ignore
  116.      204     116 43.1% 09-Feb-98 08:37:14 +Makefile
  117.      367     236 35.6% 09-Feb-98 08:38:44 +older.c
  118.      165     118 28.4% 09-Feb-98 08:34:48 +older.h
  119.      781     413 47.1% 14-Feb-98 20:13:40 +sepp.c
  120.      628     277 55.8% 06-Sep-98 16:34:42 +manual.info
  121.     5775    2600 54.9% 16-Apr-01 05:27:36 +beyond.html
  122.     6506    2689 58.6% 16-Apr-01 05:27:24 +dictionary.html
  123.     8262    3379 59.1% 16-Apr-01 05:31:08 +future.html
  124.      138     138  0.0% 14-Jan-96 17:27:46 +back.gif
  125.      190     190  0.0% 14-Jan-96 17:20:08 +copy.gif
  126.      170     170  0.0% 14-Jan-96 17:14:34 +index.gif
  127.      176     176  0.0% 14-Jan-96 17:14:44 +main.gif
  128.      189     189  0.0% 14-Jan-96 17:15:02 +next.gif
  129.      168     168  0.0% 14-Jan-96 17:28:12 +noback.gif
  130.      211     211  0.0% 14-Jan-96 17:20:36 +nocopy.gif
  131.      200     200  0.0% 14-Jan-96 17:15:28 +noindex.gif
  132.      193     193  0.0% 16-Apr-01 04:46:52 +nomain.gif
  133.      212     212  0.0% 14-Jan-96 17:15:52 +nonext.gif
  134.      213     213  0.0% 15-Jul-96 23:44:28 +noprev.gif
  135.      188     188  0.0% 14-Jan-96 17:16:08 +prev.gif
  136.      141     141  0.0% 04-Nov-95 02:20:36 +up.gif
  137.      981     981  0.0% 21-Feb-98 01:00:48 +vahunz-now.gif
  138.     1553    1553  0.0% 19-Apr-98 18:40:04 +vahunz.gif
  139.     2765    2765  0.0% 25-Sep-98 08:07:24 +verhunz.gif
  140.     4472    1896 57.6% 16-Apr-01 05:26:46 +index.html
  141.      481     256 46.7% 06-Sep-98 16:34:38 +index.html.info
  142.     5867    2545 56.6% 16-Apr-01 05:27:34 +inside.html
  143.     2592    1164 55.0% 16-Apr-01 05:27:30 +keyctionary.html
  144.     3484    1676 51.8% 16-Apr-01 15:40:28 +legal.html
  145.     5507    2423 56.0% 16-Apr-01 05:26:58 +overview.html
  146.     3416    1677 50.9% 16-Apr-01 05:27:06 +problems.html
  147.    12347    4779 61.2% 16-Apr-01 05:26:52 +reference.html
  148.     1534     750 51.1% 16-Apr-01 05:27:08 +requirements.html
  149.     2945    1383 53.0% 16-Apr-01 05:27:38 +source.html
  150.     2256    1057 53.1% 16-Apr-01 05:44:34 +support.html
  151.     2431    1166 52.0% 17-Sep-98 14:18:40 +tschak.html
  152.    10868    4339 60.0% 16-Apr-01 05:26:56 +tutorial.html
  153.     2056     964 53.1% 16-Apr-01 05:27:14 +use-case-1.html
  154.     4923    2071 57.9% 16-Apr-01 05:27:16 +use-case-2.html
  155.     2913    1349 53.6% 16-Apr-01 05:27:18 +use-case-3.html
  156.     3469    1687 51.3% 16-Apr-01 05:27:20 +use-case-4.html
  157.     3007    1400 53.4% 16-Apr-01 05:27:26 +use-case-5.html
  158.     2972    1374 53.7% 16-Apr-01 05:27:28 +use-case-6.html
  159.     1195     343 71.2% 19-Apr-98 16:08:14 +compile
  160.    25256    9275 63.2% 24-Oct-97 04:36:18 +COPYING.LIB
  161.     5701    1754 69.2% 17-Apr-01 13:51:44 +ubi_AVLtree.c
  162.     1945     848 56.4% 17-Apr-01 13:51:46 +ubi_AVLtree.h
  163.     6273    2269 63.8% 17-Apr-01 13:51:46 +ubi_BinTree.c
  164.     3065    1288 57.9% 17-Apr-01 13:51:48 +ubi_BinTree.h
  165.     6893    2046 70.3% 17-Apr-01 13:51:50 +expstr.c
  166.     2552     915 64.1% 17-Apr-01 13:51:50 +expstr.h
  167.     1105     499 54.8% 17-Apr-01 13:51:50 +udebug.h
  168.     7975    2859 64.1% 17-Apr-01 13:51:52 +umemory.c
  169.     2306     876 62.0% 17-Apr-01 13:51:52 +umemory.h
  170.     3398    1392 59.0% 17-Apr-01 13:51:54 +ustring.c
  171.     1600     707 55.8% 17-Apr-01 13:51:54 +ustring.h
  172.     1953     768 60.6% 17-Apr-01 13:51:56 +utypes.h
  173.     2236     923 58.7% 17-Apr-01 13:51:56 +keywords.c
  174.    25186    8776 65.1% 17-Apr-01 13:51:58 +vahunz.c
  175.     1074     515 52.0% 17-Apr-01 13:51:58 +vahunz_rev.h
  176.     3860    2448 36.5% 16-Sep-98 03:33:02 +blank-to-hyphen
  177.      466     253 45.7% 16-Sep-98 03:32:52 +blank-to-hyphen.c
  178.      886     397 55.1% 02-Sep-98 08:08:24 +def_vahunz.info
  179.     2035     806 60.3% 16-Aug-99 15:56:58 +scan_javadoc.e
  180.       42      39  7.1% 12-Aug-99 16:48:56 +SCOPTIONS
  181.    36516   20932 42.6% 16-Apr-01 05:20:54 +vahunz
  182.    31784    7522 76.3% 16-Aug-99 21:43:08 +Vahunz-Tschak
  183.      930     430 53.7% 16-Sep-98 03:18:08 +Vahunz-Tschak.info
  184.     2598    1373 47.1% 17-Apr-01 13:51:32 +vahunz.readme
  185.      496     267 46.1% 04-Sep-98 13:29:12 +vahunz.readme.info
  186. -------- ------- ----- --------- --------
  187.   841541  307490 63.4% 25-Apr-101 22:01:00   76 files
  188.